/*
 *  Copyright 2005 Blandware (http://www.blandware.com)
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package com.blandware.atleap.webapp.action.questionnaire.questionnaire;

import com.blandware.atleap.webapp.action.core.BaseAction;
import com.blandware.atleap.webapp.form.questionnaire.QuestionnaireForm;
import com.blandware.atleap.webapp.util.core.LocaleUtil;
import com.blandware.atleap.webapp.util.core.WebappConstants;
import com.blandware.atleap.webapp.util.core.WebappUtil;
import com.blandware.atleap.webapp.util.questionnaire.QuestionnaireModuleWebConstants;
import org.apache.commons.validator.GenericValidator;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.action.ActionMessage;
import org.apache.struts.action.ActionMessages;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.List;

/**
 * <p>Prepares form bean to create questionnaire annotation.</p>
 * <p><a href="CallCreateQuestionnaireAnnotationAction.java.html"><i>View source</i></a></p>
 *
 * @author Roman Puchkovskiy <a href="mailto:roman.puchkovskiy@blandware.com">
 *         &lt;roman.puchkovskiy@blandware.com&gt;</a>
 * @version $Revision: 1.3 $ $Date: 2008/04/29 17:51:55 $
 * @struts.action path="/questionnaire/questionnaire/callCreateAnnotation"
 * input="inputForward"
 * name="questionnaireForm"
 * scope="request"
 * validate="false"
 * roles="questionnaire-item-create"
 * @struts.action-forward name="inputForward"
 * path=".questionnaire.questionnaire.create"
 * @struts.action-forward name="createQuestionnaireAnnotation"
 * path=".questionnaire.questionnaire.createAnnotation"
 * @struts.action-forward name="listQuestionnaires"
 * path="/questionnaire/questionnaire/list.do"
 * redirect="true"
 */
public final class CallCreateQuestionnaireAnnotationAction extends BaseAction {
	/**
	 * @param mapping  The ActionMapping used to select this instance
	 * @param form     The optional ActionForm bean for this request (if any)
	 * @param request  The HTTP request we are proceeding
	 * @param response The HTTP response we are creating
	 * @return an ActionForward instance describing where and how
	 *         control should be forwarded, or null if response
	 *         has already been completed
	 */
	public ActionForward execute(ActionMapping mapping, ActionForm form,
	                             HttpServletRequest request, HttpServletResponse response) throws Exception {

		request.getSession().removeAttribute(QuestionnaireModuleWebConstants.QUESTIONNAIRE_SUBMITTED_ACTION_KEY);

		if ( isCancelled(request) ) {
			return mapping.findForward("listQuestionnaires");
		}
		QuestionnaireForm questionnaireForm = (QuestionnaireForm) form;

		// Check whether user came here not from previous page (or he switched
		// edit mode/languge during creating questionnaire)
		String localesMode = questionnaireForm.getLocalesMode();
		if ( !"current".equalsIgnoreCase(localesMode) && !"all".equalsIgnoreCase(localesMode) && questionnaireForm.getAnnotationCheckedBoxes().size() == 0 ) {
			request.setAttribute("beginPage", mapping.findForward("listQuestionnaires").getPath());
			return mapping.findForward("unsatisfiablePage");
		}

		if ( !WebappUtil.hasCorrectValues(questionnaireForm.getTitleMap()) ) {
			// title must be specified

            // check 'check all' ckeckbox if needed
            questionnaireForm.setAllCheckedFlagForAnnotationCheckboxes(request, localesMode);

			request.getSession().removeAttribute(QuestionnaireModuleWebConstants.QUESTIONNAIRE_SUBMITTED_ACTION_KEY);
			ActionMessages errors = new ActionMessages();
			errors.add("title", new ActionMessage("core.commons.errors.required", getMessage(request, "questionnaire.questionnaire.form.title")));
			saveErrors(request, errors, false);
			saveToken(request);
			return mapping.getInputForward();
		}

		String redirectUrl = request.getParameter("redirectUrl");
		if ( GenericValidator.isBlankOrNull(redirectUrl) ) {
			redirectUrl = (String) request.getAttribute(WebappConstants.REDIRECT_URL_KEY);
		}
		if ( !GenericValidator.isBlankOrNull(redirectUrl) ) {
			request.getSession().setAttribute(WebappConstants.REDIRECT_URL_KEY, redirectUrl);
		} else {
			request.getSession().removeAttribute(WebappConstants.REDIRECT_URL_KEY);
		}

		if ( !"current".equals(localesMode) && !"all".equals(localesMode) ) {
			localesMode = "selected";
		}
		questionnaireForm.setLocalesMode(localesMode);

		List contentLocales = LocaleUtil.getInstance(servlet.getServletContext()).getEnabledLocales();

		request.getSession().setAttribute(WebappConstants.CONTENT_LOCALES_COLLECTION_KEY, contentLocales);

		// save transaction token in request
		saveToken(request);
		return mapping.findForward("createQuestionnaireAnnotation");
	}
}
